////////////////////////////////////////////////////////////////////////////////
// This file is part of the Mist compiler.                                    //
//                                                                            //
// Copyright (C) 2008, 2009 The Mist project                                  //
//                                                                            //
// For a list of contributors, see the COMMITTERS file.                       //
//                                                                            //
// The Mist compiler is free software: you can redistribute it and/or modify  //
// it under the terms of the GNU General Public License as published by       //
// the Free Software Foundation, either version 3 of the License, or          //
// (at your option) any later version.                                        //
//                                                                            //
// The Mist compiler is distributed in the hope that it will be useful,       //
// but WITHOUT ANY WARRANTY; without even the implied warranty of             //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              //
// GNU General Public License for more details.                               //
//                                                                            //
// You should have received a copy of the GNU General Public License          //
// in the COPYING file. If not, see <http://www.gnu.org/licenses/>.           //
////////////////////////////////////////////////////////////////////////////////

///
/// \file
/// Contains the Position class.
///

#ifndef POSITION_HPP
#define POSITION_HPP

////////////////////////////////////////////////////////////////////////////////
// Includes                                                                   //
////////////////////////////////////////////////////////////////////////////////

#include <string>
using std::string;

#include <ostream>
using std::ostream;

#include <boost/operators.hpp>
using boost::equivalent;
using boost::equality_comparable;
using boost::partially_ordered;

#include <boost/optional.hpp>
using boost::optional;

#include "common/outputproducer.hpp"

namespace yy { class position; }

////////////////////////////////////////////////////////////////////////////////
// Position Class                                                             //
////////////////////////////////////////////////////////////////////////////////

/// A character position in the code. File, Line, Column.
///
class Position : equivalent<Position, partially_ordered<Position, equality_comparable<Position> > >, public OutputProducer {
	public:
		
		/// Construct a new position.
		///
		Position(
			const string& f, ///< the file
			uint l,          ///< the line
			uint c           ///< the column
		);
		
		
		/// Construct a new Location, initialized to \a l.
		///
		Position(
			const yy::position& pos ///< a code position generated by Bison
		);
		
		/// \return the position just to the right of this one
		///
		Position successor() const;
		
		/// \return the position just to the left of this one
		///
		/// \pre this->column > 1
		///
		Position predecessor() const;
		
		/// Order \a this and \a other by file, then by line, then by column
		///
		bool operator<(const Position& other) const;
		
		ostream& send_to_stream(ostream& stream) const;
		
		string file;   ///< the file of this position
		uint   line;   ///< the line of this position
		uint   column; ///< the column of this position
};

#endif // POSITION_HPP
